C_Message is the message to display. This message may be any length, the window will auto-size itself to display the message. Any ~ (tilde) characters are translated to a {cr}{lf}.
xParam2. If xParam2 is not passed or is .F., then the window will be in the DIALOG color scheme. If xParam2 is .T. then the window will be in ALERT color scheme. If xParam2 is a character string then the character string is used as the window title. If the first character is a !, then the window will be ALERT color scheme, and the ! will be removed. The window title will be the remainder of the string. If cHelpObj is not passed, then it will default to (strtran(alltrim(xParam2),' ','_')). I.E. all trailing and leading spaces will be removed, and remaining spaces will be converted to under-scores.
C_Buttons are the optional buttons to use for the dialog box. The buttons must be separated by a semi-colon (;). If no buttons are passed, the program defaults to one button (< OK >). By default the first letter of each button is activated as a hot-key. You can override this behavior by specifying your own hot key (\<). If the button string starts with a semi-colon, or the buttons are too wide to fit on the screen horizontally, the buttons will be displayed vertically.
C_ReadOptions is an optional clause to be added to the READ clause of the message window. You can use this option to implement valid clauses, WITH clauses, etc.
cHelpObj is an optional Help Object specifier for use with CALLHELP.PRG and HELPEDIT.PRG. If this object is not passed, and there is a title passed in xParam2, then the object will default to the window title.
Returns
Upper(), Alltrim() of the Button selected. If escape was pressed, MsgWin() returns a null string, or the text of the default escape button if specified(\!).
Notes
The internal read variable is named nChoice. You can reference this variable during any read valid clauses you wish to specify. For information on the button activation/formatting commands, refer to the help for @SAY PUSH BUTTONS in the FoxPro Help file.
╓─────────────────────────────────╖
║ Examples ║
╙─────────────────────────────────╜
=MsgWin(' Some sort of message ~~The rest on line 2')
=MsgWin(' Some sort of message ~~The rest on line 2',.t.)
&& In alert color scheme
Choice=Msgwin('Do you wish to MODIFY file, ERASE file or COPY file.',.f.,'MODIFY;ERASE;COPY')
* choice now contains the button selected.
do case
case choice='MODIFY'
* modify the file
case choice='ERASE'
* erase the file
case choice='COPY'
* copy the file
endcase
Choice=Msgwin('Do you wish to MODIFY file, ERASE file or COPY file.',.f.,';\!MODIFY;ERASE;C\<OPY;\?CANCEL')
* The final demonstration shows how to use a Valid clause
result=msgwin('No floppy disk was inserted would you '+;'
'like to retry or cancel?',.t.,'Retry;Cancel','valid ISDISKIN('A') OR NCHOICE=2')
The purpose of this function is to display a message in a window, and get either OK or CANCEL from the user.
Syntax
YES( <C_Message> [, <L_AlertMode>, cRdOptions ] )
C_Message
Message to display. This message may be any length, the window will auto-size itself to display the message. Any ~ (tilde) charachters are translated to a {cr}{lf}.
X_Param2
If this variable is not passed, then the window will be DIALOG color scheme. If the variable is passed and it is logical, the window will be DIALOG color scheme if false, and ALERT color scheme if true.
If the variable passed is a character, the window will be DIALOG color scheme UNLESS the first character is an exclamation point (!). If the first character is an exclamation point, it will be ALERT color scheme, and the leading exclamation point will be removed.
C_ReadOptions
Optional clause to be added to the READ clause of the message window. You can use this option to implement valid clauses, WITH clauses, etc.
Returns
.T. if user selects OK, .F. otherwise
Notes
The internal read variable is named nChoice. You can reference this variable during any read valid clauses you wish to specify. This function is actually a wrapper around the MSGWIN() function.
╓─────────────────────────────────╖
║ Examples ║
╙─────────────────────────────────╜
&& Activate pop up window with 'ok/cancel push buttons, and msg displayed
if yes('Are you sure you want to do this?') && Window is Dialog Color
do Dangerous_thing
endif
if yes('Are you sure you want to do this?',.t.) && Window is Alert Color
